Feature: `valueof` for string, numeric and boolean literals by timotheeguerin · Pull Request #1877 · microsoft/typespec

timotheeguerin · 2023-05-01T18:45:12Z

fix #1745 Add support for valueof

Waiting on:

To be merged right before end of sprint to not block flow due to new syntax
Breaking change review [TCGC] Add test for nested paging cases Azure/typespec-azure#2977

Deprecation

Typespec

Decorators have updated to use valueof for their types when expecting a string, numeric or boolean value.

If using the decorator directly this is NOT breaking and will continue to work as expected.
If using the decorator via a template parameter the template constraint will need to be updated from string to valueof string (Similar for numeric and boolean types)

// Before
model Foo {
  @doc("My doc") name: string;
}

// After - this is the same, not breaking
model Foo {
  @doc("My doc") name: string;
}

// Before
model Foo<TDoc extends string> {
  @doc(TDoc) name: string;
}

// After
model Foo<TDoc extends valueof string> {
  @doc(TDoc) name: string;
}

The old way is still ok but will emit a deprecation warning.

Breaking change

Decorator API

Part of adding valueof is making the auto conversion of Typespec types more consistent.
A decorator that is not specifying a valueof type for its parameter will be receiving the exact type. To get the converted string, number or boolean valueof must be used

Type of parmeter	TS type before	Ts Type now
`string`	`string`	`StringLiteral \| Scalar`
`int32`	`number`	`NumericLiteral \| Scalar`
`int8`	`number`	`NumericLiteral \| Scalar`
`float32`	`number`	`NumericLiteral \| Scalar`
`boolean`	`boolean`	`BooleanLiteral \| Scalar`
`boolean`	`boolean`	`BooleanLiteral \| Scalar`
`valueof string`		`string`
`valueof int32`		`number`
`valueof float64`		`number`
`valueof boolean`		`boolean`

Example migration

// Before
extern dec doc(target: unknown, value: string);

// After
extern dec doc(target: unknown, value: valueof string);

Example mapping `extern dec` to `typescript signature`

Cadl	Ts Signature
`dec foo(target, value: string)`	export function $foo( context, target, value: StringLiteral \| TemplateLiteral \| Scalar ) {}
`dec foo(target, value: valueof string)`	export function $foo(context, target, value: string) {}
`dec foo(target, value: TemplateLiteral)`	export function $foo(context, target, value: TemplateLiteral) {}

…ture/valueof

github-actions · 2023-05-01T18:45:26Z

Changes in this PR will be published to the following url to try(check status of TypeSpec Pull Request Try It pipeline for publish status):
Playground: https://cadlplayground.z22.web.core.windows.net/prs/1877/

Website: https://cadlwebsite.z1.web.core.windows.net/prs/1877/

…ypespec into feature/valueof

MaryGao · 2023-06-06T07:28:50Z

    args: DecoratorArgument[],
    decoratorNode: Node
-  ): boolean {
+  ): [boolean, DecoratorArgument[]] {


@timotheeguerin We have a test failed (ci link) with below error, could you take a look?

Here is our test case link, we have a usage for @extension("x-ms-skip-url-encoding", true).

TypeError: key.startsWith is not a function at isOpenAPIExtensionKey (file:///home/vsts/work/1/s/common/temp/node_modules/.pnpm/@typespec+openapi@0.44.0_5dsz42v7r7ljwzbfu2zuum3liq/node_modules/@typespec/openapi/src/decorators.ts:75:14) at $extension (file:///home/vsts/work/1/s/common/temp/node_modules/.pnpm/@typespec+openapi@0.44.0_5dsz42v7r7ljwzbfu2zuum3liq/node_modules/@typespec/openapi/src/decorators.ts:42:8) at applyDecoratorToType (file:///home/vsts/work/1/s/common/temp/node_modules/.pnpm/@typespec+compiler@0.45.0-dev.26/node_modules/@typespec/compiler/core/checker.ts:5480:5) at finishTypeForProgramAndChecker (file:///home/vsts/work/1/s/common/temp/node_modules/.pnpm/@typespec+compiler@0.45.0-dev.26/node_modules/@typespec/compiler/core/checker.ts:5456:7) at finishType (file:///home/vsts/work/1/s/common/temp/node_modules/.pnpm/@typespec+compiler@0.45.0-dev.26/node_modules/@typespec/compiler/core/checker.ts:3705:12) at checkModelProperty (file:///home/vsts/work/1/s/common/temp/node_modules/.pnpm/@typespec+compiler@0.45.0-dev.26/node_modules/@typespec/compiler/core/checker.ts:2993:7) at checkModelProperties (file:///home/vsts/work/1/s/common/temp/node_modules/.pnpm/@typespec+compiler@0.45.0-dev.26/node_modules/@typespec/compiler/core/checker.ts:2481:25) at checkModelStatement (file:///home/vsts/work/1/s/common/temp/node_modules/.pnpm/@typespec+compiler@0.45.0-dev.26/node_modules/@typespec/compiler/core/checker.ts:2393:5) at checkModel (file:///home/vsts/work/1/s/common/temp/node_modules/.pnpm/@typespec+compiler@0.45.0-dev.26/node_modules/@typespec/compiler/core/checker.ts:2324:14) at getTypeForNode (file:///home/vsts/work/1/s/common/temp/node_modules/.pnpm/@typespec+compiler@0.45.0-dev.26/node_modules/@typespec/compiler/core/checker.ts:615:16) Error: TypeSpec compiler v0.44.0

Are you using all the latest dev version or stable version?

This happens in our nightly build which always refer the latest dev to check any breaking.

Do you have @typespec/openapi as an explicit dependency in your package.json? I think it it is not the tool will not bump it and due to how npm resolve things it will not use the dev version.

We just released the stable versions, if you can repro with 0.45.0(core) and 0.31.0(azure) then it is probably an issue but from the error I am pretty sure it is a mismatch of deps

I can't repro with your spec in the playground

Thanks for the info! Let me deep dive if any dependency mismatch.

timotheeguerin added 7 commits April 17, 2023 11:23

Parse valueof

65fbbd3

Parse valueof

566c1f7

Merge branch 'main' of https://github.com/Microsoft/typespec into fea…

0f98a44

…ture/valueof

Basic validation

987cb50

Some tests

128711f

Fix

a9cba02

Works in template constraints

a114d0c

timotheeguerin added 2 commits May 1, 2023 12:39

Fix tests

8f46e60

change marshalling rules

0840853

bterlson reviewed May 1, 2023

View reviewed changes

Comment thread packages/compiler/core/types.ts

timotheeguerin added 6 commits May 2, 2023 10:06

Add grammar and regen docs

64843fb

Add colorization tests

f7b9fef

Fix

ce62ffb

Merge branch 'main' into feature/valueof

96a4da6

Merge branch 'feature/valueof' of https://github.com/timotheeguerin/t…

c8b40ef

…ypespec into feature/valueof

Add backcompat from template constraint

8c69389

timotheeguerin mentioned this pull request May 2, 2023

Deprecation tracking #1873

Closed

timotheeguerin added the breaking-change A change that might cause specs or code to break label May 3, 2023

timotheeguerin added 3 commits May 24, 2023 09:50

Merge with main

1faad39

Add docs

db49ae4

Merge branch 'main' into feature/valueof

2bfc68c

timotheeguerin marked this pull request as ready for review May 24, 2023 16:59

timotheeguerin requested review from allenjzhang, daviwil, markcowl and nguerrera as code owners May 24, 2023 16:59

timotheeguerin added 3 commits May 24, 2023 10:16

Changelog

8d9054c

Format

6194e04

Fix lint

6be312a

timotheeguerin added 6 commits May 24, 2023 11:20

remove console.log

389f5ed

Fix petstore decorators

a93affa

Merge with main

a7cbd1b

fix

2f64651

regen docs

08db01a

MErge with main

49669b3

markcowl approved these changes Jun 2, 2023

View reviewed changes

Comment thread packages/compiler/core/checker.ts

Merge branch 'main' into feature/valueof

c7743b4

timotheeguerin merged commit 6733c5b into microsoft:main Jun 2, 2023

timotheeguerin deleted the feature/valueof branch June 2, 2023 20:35

MaryGao reviewed Jun 6, 2023

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Feature: `valueof` for string, numeric and boolean literals#1877

Feature: `valueof` for string, numeric and boolean literals#1877
timotheeguerin merged 28 commits intomicrosoft:mainfrom
timotheeguerin:feature/valueof

timotheeguerin commented May 1, 2023 •

edited

Loading

Uh oh!

github-actions Bot commented May 1, 2023

Uh oh!

Uh oh!

Uh oh!

MaryGao Jun 6, 2023 •

edited

Loading

Uh oh!

timotheeguerin Jun 6, 2023

Uh oh!

MaryGao Jun 7, 2023

Uh oh!

timotheeguerin Jun 7, 2023 •

edited

Loading

Uh oh!

timotheeguerin Jun 7, 2023

Uh oh!

MaryGao Jun 8, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Conversation

timotheeguerin commented May 1, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Deprecation

Typespec

Breaking change

Decorator API

Example migration

Example mapping extern dec to typescript signature

Uh oh!

github-actions Bot commented May 1, 2023

Uh oh!

Uh oh!

Uh oh!

MaryGao Jun 6, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

timotheeguerin Jun 6, 2023

Choose a reason for hiding this comment

Uh oh!

MaryGao Jun 7, 2023

Choose a reason for hiding this comment

Uh oh!

timotheeguerin Jun 7, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

timotheeguerin Jun 7, 2023

Choose a reason for hiding this comment

Uh oh!

MaryGao Jun 8, 2023

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

timotheeguerin commented May 1, 2023 •

edited

Loading

Example mapping `extern dec` to `typescript signature`

MaryGao Jun 6, 2023 •

edited

Loading

timotheeguerin Jun 7, 2023 •

edited

Loading